Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update K8s example #3493

Merged
merged 15 commits into from
Nov 22, 2023
Merged

Update K8s example #3493

merged 15 commits into from
Nov 22, 2023

Conversation

tillprochaska
Copy link
Contributor

@tillprochaska tillprochaska commented Nov 9, 2023

The previous example for running Aleph in a local Kubernetes cluster was based on kind. This simplifies the example and default configuration, making it easier to run a minimal Aleph instance in a local Kubernetes cluster provided by Docker Desktop.

Additionally, this PR includes two changes to the Aleph Helm chart:

  • Sets the default ingest-file version to 3.19.3, the latest release (the default version in the chart was out of sync with the latest release).

  • Marks the SENTRY_DSNkey ref as optional. This way, starting containers will succeed, even if the SENTRY_DSN key does not exist in the aleph-secrets secret. Previously, starting containers that reference the SENTRY_DSN key would fail (requiring users to manually create an empty SENTRY_DSN key in the aleph-secrets secret).

@tillprochaska tillprochaska force-pushed the fix/k8s-example branch 5 times, most recently from 7116e8a to bd13669 Compare November 10, 2023 11:36
Otherwise a Helm chart for ES 8 will be used, which by default installs ES 8 and has some breaking changes with regards to the structure of values.
This adjusts the example so that it can be easily run on a single-node K8s cluster provided by Docker Compose. I have also tweaked the default values to reduce the resources to a minimum and tried to make the example as easy to install as possible.
@tillprochaska tillprochaska marked this pull request as ready for review November 10, 2023 14:17
helm/examples/dev/templates/ingress.yaml Outdated Show resolved Hide resolved
helm/examples/dev/secrets/minio/secretKey Outdated Show resolved Hide resolved
dependencies:
- name: aleph
repository: file://../../charts/aleph
version: 3.15.4
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if I did something wrong, but I get aleph 3.15.1 :/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, that’s weird… I just reset my cluster, removed local images, and set up everything again from scratch. But looking at the about page and at the version specified inside of the container I see 3.15.4. We could look into it together tomorrow if you’d like :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only other reason for this I could imagine is that this branch used to be based off of 3.15.1, and I later rebased it and force pushed to be up to date with develop. But that was a few days before you looked at it, I think…

@tillprochaska tillprochaska merged commit 96e37f9 into develop Nov 22, 2023
2 checks passed
simonwoerpel pushed a commit to investigativedata/aleph that referenced this pull request Apr 22, 2024
* Update example values to work with current Postgres chart version

* Add ingress class annotation to ensure the Nginx ingress doesn’t ignore the ingress resource

* Use ES Helm chart for ES 7

Otherwise a Helm chart for ES 8 will be used, which by default installs ES 8 and has some breaking changes with regards to the structure of values.

* Mark secret key ref for `SENTRY_DSN` as optional

* Update K8s example

This adjusts the example so that it can be easily run on a single-node K8s cluster provided by Docker Compose. I have also tweaked the default values to reduce the resources to a minimum and tried to make the example as easy to install as possible.

* Emphasize that selecting the correct kubectl context may be necessary

* Update default ingest-file version in Helm chart

* Add note on Docker Desktop memory resource limits

* Add note about `kubernetes.docker.internal` host

* Add upgrade instructions

* Simplify secrets setup

* Document how to create a user, known issues

* Fix typo

* Replace deprecated `kubernetes.io/ingress.class` annotation

As suggested by @stchris

* Fix default ingest-file version in Helm chart (again…)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants